home *** CD-ROM | disk | FTP | other *** search
/ PC World Interactive 7 / PC World Interactive 7.iso / pcgames / EMERGY / BC5 / SCRIPT / EXAMPLES / readme.txt
Text File  |  1997-03-25  |  7KB  |  192 lines
  1. cSCRIPT EXAMPLES
  2. ----------------
  3.  
  4. Contents
  5. --------
  6. I. "Installation" of example scripts.
  7. II. Example script descriptions.
  8.  
  9.  
  10. I. "Installation" of example scripts.
  11. -------------------------------------
  12. You can "install" the example scripts by choosing "Script | Install/Uninstall
  13. examples." This loads, and causes to be loaded on start-up, the Script
  14. Manager. The Script Manager is an example script for setting up and working
  15. with scripts. It has a default configuration designed to make it easy for
  16. you to explore the functionality the examples provide.
  17.  
  18. Once installed, you'll find selected scripts on the "Example scripts" menu.
  19. Choose "Example scripts | Script directory" to see all the selected examples,
  20. including those the Script Manager knows of but does not add to the menu.
  21.  
  22. You can customize the Script Manager and maintain it as a part of your IDE,
  23. changing the scripts, the menus they are assigned to, their autoload statuses,
  24. etc. Or you can remove it by choosing "Script | Install/Uninstall examples"
  25. again. For more information about the Script Manager, see the entry below and
  26. the file headers for SPPMAN.SPP and its related files.
  27.  
  28.  
  29. II. Example script descriptions.
  30. --------------------------------
  31. The script examples directory contains the following scripts and script
  32. applets:
  33.  
  34. SCRIPT MANAGEMENT
  35. -----------------
  36. SPPMAN.SPP    Script Manager. Allows you to specify scripts for
  37.         autoloading, and add scripts to IDE menus. Provides a script
  38.         directory showing script names, descriptions, and autoload
  39.         and load statuses. The directory window lets you load and
  40.         unload scripts, edit them in the specified editor, and edit
  41.         the Script Manager data file.
  42.  
  43. LOADLAST.SPP    Load Last Script. Loads the last-loaded script. Useful for
  44.         frequently reloading a script under development (before it
  45.         is assigned to a hot key, menu, or some other quick trigger).
  46.  
  47. TEST.SPP    Test harness.
  48.  
  49.  
  50. EDITING AND CODING
  51. ------------------
  52. APIEXP.SPP    API Expander. Expands current word in editor to the matching
  53.         Windows API or C RTL signiture. Provides selection list if
  54.         seed string has multiple matches. If the match is an RTL
  55.         member, API Expander indicates if the corresponding header
  56.         file needs to be added to the source file.
  57.  
  58. CODELIB.SPP    Code Library. Displays libraries of code snippets you can
  59.         insert in the current buffer. You can also edit code library
  60.         data files, and create library entries from selected text.
  61.         You can create as many code libraries as you want.
  62.  
  63. EDONLY.SPP    Edit-only. Temporarily shows only those lines in the current
  64.         buffer that contain a specified string. Useful for seeing how
  65.         an identifier is being used, making changes without searching
  66.         and replacing, isolating strings for spell-checking, etc.
  67.  
  68. SHIFTBLK.SPP    Shift Block. Shifts the current block right or left a column
  69.         at a time.
  70.  
  71. OPENHDR.SPP    Open Header. Opens the .h or .hpp file corresponding to the
  72.         current source file. Optionally creates a header file if one
  73.         does not exist.
  74.  
  75. FILEINSR.SPP    File Insert. Inserts a file into the current buffer.
  76.  
  77. ALIGNEQ.SPP    Align at Equals. Aligns a block of assignments by
  78.         positioning the equals operators one space after the longest
  79.         lvalue in the current block.
  80.  
  81. REVISIT.SPP    Code Revisit Tool. Quickly lists occurrences of a 
  82.         configurable "revisit this code" marker in all files in the
  83.         specified directory.
  84.  
  85. LONGLINE.SPP    Long Line Finder. Searches all .C, .H, .CPP, .HPP, and .SPP
  86.         files in the specified directory and reports all lines that
  87.         are longer than a given threshold value to the message
  88.         database. Double-click a message to edit the referenced file.
  89.  
  90. FINDTABS.SPP    Find Tabs. Searches all .C, .H, .CPP, .HPP, and .SPP files
  91.         in the specified directory and reports all lines that have
  92.         at least one tab character to the message database. Double-
  93.         click a message to edit the referenced file. Useful for
  94.         coding styles that don't use tab characters.
  95.  
  96. EDITSIZE.SPP    Editor Size. Allows easy customization of editor window
  97.         size and position without changing default values in
  98.         startup.spp. Config.spp provides a different but more
  99.         comprehensive approach to positioning IDE windows.
  100.  
  101. COMMENT.SPP    Commenter. "Comments-out" the selected block, or
  102.         uncomments the lines if they are already commented.
  103.  
  104. SRCHALL.SPP    Search All. Searches and replaces across files in the
  105.         current project.
  106.  
  107.  
  108. DEBUGGING
  109. ---------
  110. EVALTIPS.SPP    Evaluation Tips. When the debugger has a process loaded,
  111.         evaluates the item under the cursor and displays the result
  112.         in a mouse tip.
  113.  
  114. VIEWLOCS.SPP    View Locals. Inspects local variables if the debugger has
  115.         a process. 
  116.  
  117.  
  118. PROJECT MANAGEMENT
  119. ------------------
  120. LOADPROJ.SPP    Load Project. Opens the last project on start-up.
  121.  
  122. PRJNOTES.SPP    Project Notes. For new projects, creates a notes text file
  123.         in the project directory and adds it to the project. The
  124.         notes file will contain any text found in a template file.
  125.  
  126.  
  127. MISCELLANEOUS
  128. -------------
  129. FASTOPEN.SPP    Fast Open. Opens files and projects based on a search
  130.         path, so you don't have to navigate directories.
  131.  
  132. AUTOSAVE.SPP    Autosave. Saves files, environment, desktop, project, and/or
  133.         messages at the specified interval.
  134.  
  135. NETHELP.SPP    Internet Help. Open an URL with Netscape Navigator by
  136.         selecting from a list of programming pages, FTP sites,
  137.         and newsgroups.
  138.  
  139. SOUND.SPP    Sound Enabler. Plays WAV files on specified IDE events, such
  140.         as Build Failure.
  141.  
  142. KEYASSGN.SPP    Key Assignments. Shows what commands are assigned to a given
  143.         key sequence.
  144.  
  145. DIRTOOL.SPP    Directory Tool. Creates a new tool called "Directory
  146.         Listing," which takes a filespec and generates a directory
  147.         listing in the message window.
  148.  
  149. CONFIG.SPP    Configure Windows. Resizes and positions IDE windows as
  150.         they are created. Also maps keys in the default and classic
  151.         keyboards for buffer manipulation.
  152.  
  153. SUPPORT CLASSES AND ROUTINES
  154. ----------------------------
  155. SORT.SPP    Sort. Quick Sort routines.
  156.  
  157. FOREACH.SPP    For Each. Calls a function for all the nodes of the given type
  158.         in a project.
  159.  
  160. FILE.SPP    File Classes. Includes configuration file management.
  161.  
  162. MSG.SPP        Message Class. Provides methods to simplify and standardize
  163.         user messages. Message captions automatically indicate the
  164.         calling module.
  165.  
  166. MISC.SPP    Miscellaneous. Miscellaneous script.
  167.  
  168.  
  169. DEMONSTRATION
  170. -------------
  171. INTNATL.SPP    International. Demonstrates the use of FormatString() for
  172.         localization of strings in scripts.
  173.  
  174. CRTL.SPP    C RTL. Demonstrates script access to the C RTL by writing
  175.         Albert's words to a file.
  176.  
  177. AUTO.SPP    Automation. Demonstrates the IDE as an OLE automation
  178.         controller and server.
  179.  
  180. LIST.SPP    List Window. Demonstrates a simple sorted list window.
  181.  
  182. POPUP.SPP    Popup Window. Demonstrates a simple popup window.
  183.  
  184. MLIST.SPP    Multi-select List Window. Demonstrates a simple multiple-
  185.         selection list window. Also shows how to position a popup
  186.         window in the list.
  187.  
  188. MODLIST.SPP    Module List. Demonstrates how to handle events from
  189.         other objects to maintain the contents of a list.
  190.         Implements some of the functionality provided by the
  191.         "Script | Modules" dialog.
  192.